lib/repo: Clarify docs for importing w/ trust
authorMatthew Leeds <matthew.leeds@endlessm.com>
Mon, 3 Dec 2018 23:27:39 +0000 (15:27 -0800)
committerAtomic Bot <atomic-devel@projectatomic.io>
Tue, 4 Dec 2018 01:01:08 +0000 (01:01 +0000)
The way _ostree_repo_import_object() is written, a hardlink copy is only
attempted if the source repo is trusted, so update the docs for
ostree_repo_import_object_from_with_trust() to reflect that.

Closes: #1777
Approved by: cgwalters

src/libostree/ostree-repo.c

index f5231db98908a5740826b0f88a75ceee95c8a318..fc8844812221f91068c110cb249fc7d211fe7053 100644 (file)
@@ -4214,9 +4214,9 @@ ostree_repo_import_object_from (OstreeRepo           *self,
  * @error: Error
  *
  * Copy object named by @objtype and @checksum into @self from the
- * source repository @source.  If both repositories are of the same
- * type and on the same filesystem, this will simply be a fast Unix
- * hard link operation.
+ * source repository @source. If @trusted is %TRUE and both
+ * repositories are of the same type and on the same filesystem,
+ * this will simply be a fast Unix hard link operation.
  *
  * Otherwise, a copy will be performed.
  */